/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    https://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package org.grails.exceptions.reporting

/**
 * Defines method for pretty printing Stack traces.
 *
 * @author Graeme Rocher
 * @since 2.0
 */
interface StackTracePrinter {

    /**
     * Pretty print the given stack trace and return the result
     *
     * @param throwable The throwable
     * @return The result
     */
    @Deprecated
    String prettyPrint(Throwable throwable)

    /**
     * Pretty print the given stack trace and return the result
     *
     * @param throwable The throwable
     * @param optional attributes for formatting
     * @return The result
     */
    String prettyPrint(Throwable throwable, Map attrs)

}
